-
-
Notifications
You must be signed in to change notification settings - Fork 1.2k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
WIP: Add new long_description_content_type kwarg #708
Conversation
This is used to populate the newly proposed `Description-Content-Type` field, that is proposed in pypa/packaging.python.org#258.
b6fd44c
to
cdb4700
Compare
I would like to add a test for this. Not expecting it to be difficult, but pointers to similar tests and such would be appreciated. |
Given that the code is in It's an old package, so I'd say there's lots of cruft here - don't assume because you find it that it's recommended. Rely on pytest docs and your best instincts to put together the best tests you can. Thanks for all the work on this. |
For Which makes me think: is there a PEP defining this new field ? Should the |
There is no PEP, but there is a PR to update the "Python Packaging Guide. @ncoghlan said on the distutils-sig mailing list that opening a a PR to PyPUG was the proper way now to propose new metadata fields as it's less of a barrier to entry than writing a PEP. I'm not sure if that's a precursor to creating a PEP or replaces it? Also I'm not sure whether adding one optional field requires the metadata version to be bumped or not. I'll let someone else chime in here on the proper procedure and I'll follow whatever it is. Thanks for the test pointers! |
Added a simple test in bd5403e, borrowing from the tests that @xavfernandez mentioned. |
Test that specifying a `long_description_content_type` keyword arg to the `setup` function results in writing a `Description-Content-Type` line to the `PKG-INFO` file in the `<distribution>.egg-info` directory. `Description-Content-Type` is described at pypa/packaging.python.org#258
bd5403e
to
ebcdac8
Compare
ebcdac8
to
f1343b3
Compare
Yep, the PR-to-PyPUG is sufficient to add the new field (once accepted) - my view is that bumping the spec version mainly matters if we change the meaning of an existing field, since new fields are trivially detected by checking for them directly and having a defined fallback assumption to use if the field isn't found. More generally, pypa/pypa.io#11 covers the status of the (currently stalled) efforts to both streamline and properly document the way we use the PEP process as part of PyPA interoperability discussions. |
f1343b3
to
ebcdac8
Compare
It doesn't look like the AppVeyor failure is related to my change, but not 100% sure. |
Indeed - tests are now passing. |
Cool, thanks @jaraco! |
@msabramo Is this still a work in progress? |
Possibly. I need to check the latest discussions on this idea which might be spread out on a few PRs and emails. And I'll be AFK for a few days so I won't have time to do it right away but it's on my list to do. |
As mentioned, this would follow
pypa/packaging.python.org#258 which also
looks lonely
…On Thu, Dec 29, 2016, 09:37 Jason R. Coombs ***@***.***> wrote:
@msabramo <https://github.com/msabramo> Is this still a work in progress?
—
You are receiving this because you were mentioned.
Reply to this email directly, view it on GitHub
<#708 (comment)>, or mute
the thread
<https://github.com/notifications/unsubscribe-auth/AFDVlHX3xw2Ak1j8Cg0IvXC6dycwXjr6ks5rM8WYgaJpZM4JY1AN>
.
|
Yep. I need to check all the things and won't be able to for a bit. If anyone is itching to help, they can send PRs to my branches for any changes folks suggested. |
I'm going to close this to avoid re-reading it, though I gladly welcome anyone to revive the effort in a new PR. |
Is there something wrong with this PR or just that it is dependent on a spec change that's still TBD? Just trying to improve your open ticket stats? 😉 |
Nothing specifically wrong with it, but it does appear to be in need of some attention. Instead, it's just periodically distracting me. I like to reserve open PRs for work that's being actively developed or ready for review. |
Work in progress
This is used to populate the newly proposed
Description-Content-Type
distribution metadata field, that is proposed in pypa/packaging.python.org#258.We can discuss and evolve the implementation, but I don't think this should be merged until pypa/packaging.python.org#258 is accepted.
Related:
Description-Content-Type
field)Branch
https://github.com/msabramo/setuptools/tree/long_description_content_type
Cc: @jaraco, @dstufft, @ncoghlan, @pfmoore, @nicktimko